kanzi::EmptyNode2D Class Reference
Empty Node 2D can be used to group other 2D nodes. More...
#include <kanzi/core.ui/node/empty_node2d.hpp>
Inheritance diagram for kanzi::EmptyNode2D:
Static Public Member Functions | |
| static EmptyNode2DSharedPtr | create (Domain *domain, string_view name) |
| Creates an empty node. | |
| static EmptyNode2DSharedPtr | create (Domain *domain, string_view name, float width, float height) |
| Creates an empty node. | |
| static EmptyNode2DSharedPtr | create (Domain *domain, string_view name, float width, float height, ColorRGBA color) |
| Creates an empty node. | |
 Static Public Member Functions inherited from kanzi::Node2D | |
| static bool | isUnboundedLayoutSize (Vector2 layoutSize) |
| Returns whether a layout size is an unbound layout size. | |
| static bool | isValidLayoutSize (Vector2 size) |
| Returns whether a size is a valid layout size. | |
| static float | layoutUp () |
| Returns the direction to which the y axis grows for this node type. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static Vector2 | replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize) |
| Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. | |
| static Vector2 | replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize) |
| Replaces any element of a layout size with zero if it is unbounded and returns the size. | |
| static Vector2 | unboundedLayoutSize () |
| Returns an unbound layout size. | |
| Static Public Member Functions inherited from kanzi::Node | |
| static bool | isUnboundedLayoutValue (float layoutValue) |
| Indicates whether a value is an unbound layout value. | |
| static bool | isValidLayoutValue (float value) |
| Indicates whether a value is valid layout value. | |
| static float | replaceUnboundedLayoutValue (float layoutValue, float resetValue) |
| Replaces layout value with the specified value if it is unbounded and returns it. | |
| static float | replaceUnboundedLayoutValueWithZero (float layoutValue) |
| Replaces layout value with zero if it is unbounded layout value and returns it. | |
| static float | unboundedLayoutValue () |
| Returns an unbounded layout value. | |
| Static Public Member Functions inherited from kanzi::Object | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
| Static Public Member Functions inherited from kanzi::MetaObject | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
Additional Inherited Members | |
| Public Types inherited from kanzi::Node2D | |
| typedef ChildContainer::const_iterator | ChildConstIterator |
| Iterator type for children. | |
| typedef ChildContainer::const_reverse_iterator | ChildConstReverseIterator |
| Reverse iterator type for children. | |
| typedef vector< Node2DSharedPtr > | ChildContainer |
| Container type for children. | |
| enum | ForegroundHint { ForegroundHintNone , ForegroundHintTranslucent , ForegroundHintOpaque } |
| Hint for foreground handling of nodes. More... | |
| typedef NodeSharedPtr(* | HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData) |
| Hit test visitor function. | |
| typedef Matrix3x3 | LayoutMatrixType |
| typedef Vector2 | LayoutVectorType |
| enum | PerspectiveTransformationMode { Screen , XFov , YFov } |
| Node2D perspective transformation mode. More... | |
| enum | PixelFormat { PixelFormatRgb , PixelFormatRgba } |
| Pixel formats. More... | |
| enum | RenderType { RenderTypeNone , RenderTypeTexture , RenderTypeManual , RenderTypeManualClipped } |
| Node2D render type - affects elementary decisions about node rendering. More... | |
| Public Types inherited from kanzi::Node | |
| enum | ContentStretch { ContentStretchNone , ContentStretchFill , ContentStretchUniform , ContentStretchUniformToFill , ContentStretchRepeat } |
| Content stretch option. More... | |
| enum | DepthAlignment { DepthAlignmentBack , DepthAlignmentFront , DepthAlignmentCenter , DepthAlignmentStretch } |
| Depth alignment options. More... | |
| enum | HorizontalAlignment { HorizontalAlignmentLeft , HorizontalAlignmentRight , HorizontalAlignmentCenter , HorizontalAlignmentStretch } |
| Horizontal alignment options. More... | |
| typedef InputManipulatorContainer::const_iterator | InputManipulatorConstIterator |
| typedef vector< InputManipulatorBaseSharedPtr > | InputManipulatorContainer |
| Gets the input manipulator iterator. | |
| typedef InputManipulatorContainer::iterator | InputManipulatorIterator |
| typedef kanzi::vector< Node::MessageSubscriptionToken > | MessageSubscriptionTokenVector |
| typedef NodeComponentContainer::const_iterator | NodeComponentConstIterator |
| typedef vector< NodeComponentEntry > | NodeComponentContainer |
| Gets the node component iterator. | |
| typedef NodeComponentContainer::iterator | NodeComponentIterator |
| enum | VerticalAlignment { VerticalAlignmentBottom , VerticalAlignmentTop , VerticalAlignmentCenter , VerticalAlignmentStretch } |
| Vertical alignment options. More... | |
| typedef function< VisitorResult(Node &) | Visitor) |
| Defines the type of the function that Kanzi executes for each node when visiting a node tree. | |
| enum | VisitorOrder { VisitorPreOrder , VisitorPostOrder } |
| Defines the order in which Kanzi visits the nodes in a node tree. More... | |
| enum | VisitorResult { VisitorAbort , VisitorContinue , VisitorContinueSibling } |
| Defines the return type of the Node::Visitor function. More... | |
| Public Types inherited from kanzi::PropertyObject | |
| typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
| typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
| typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
| typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
| typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
| Public Types inherited from kanzi::BindingHostConcept | |
| using | BindingHostConceptSharedPtr |
| Binding host concept shared pointer type. | |
| using | BindingRuntimeConstIterator |
| Const iterator for binding runtimes. | |
| using | BindingRuntimeContainer |
| Container for binding runtimes. | |
| using | BindingRuntimeIterator |
| Iterator for binding runtimes. | |
| Public Member Functions inherited from kanzi::Node2D | |
| bool | addAbstractChildOverride (NodeSharedPtr child) override |
| Node::addAbstractChildOverride() implementation. | |
| void | addChild (Node2DSharedPtr child) |
| Adds a child node. | |
| void | arrange () |
| Performs layout arrangement on a 2D node. | |
| ChildConstIterator | beginChildren () const |
| bool | compositionRequiresAlpha () const |
| Returns whether composition requires alpha. | |
| bool | compositionRequiresDepth () const |
| Returns whether composition requires depth. | |
| bool | compositionRequiresStencil () const |
| Returns whether composition requires stencil. | |
| optional< Vector2 > | containsGlobal (Vector2 point) const |
| Checks whether a node area contains a point defined in screen space. If it does, writes the node-space coordinates into the outgoing point. | |
| bool | containsLocal (Vector2 point) const |
| Returns whether a node area contains a point defined in the local space of the node. | |
| ChildConstIterator | endChildren () const |
| NodeSharedPtr | findAbstractChildOverride (string_view name) override |
| Node::findAbstractChildOverride() implementation. | |
| size_t | getAbstractChildCountOverride () override |
| Node::getAbstractChildCountOverride() implementation. | |
| size_t | getAbstractChildIndexOverride (const Node &node) override |
| NodeSharedPtr | getAbstractChildOverride (size_t index) override |
| Node::getAbstractChildOverride() implementation. | |
| Vector2 | getActualSize () const |
| Gets the actual size of a node. | |
| Vector2 | getAllocatedSize () const |
| Gets the allocated size of a node. | |
| Matrix3x3 | getArrangeTransform () const |
| Gets the arrange transform. | |
| BrushSharedPtr | getBackgroundBrush () const |
| Gets value of BackgroundBrushProperty. | |
| BrushRenderer * | getBackgroundBrushRenderer () const |
| Get background brush renderer. | |
| QuadDescription | getBackgroundQuad () const |
| Gets the background quad description. | |
| Node2DSharedPtr | getChild (size_t index) const |
| Returns a child from given index from object node. | |
| Matrix3x3 | getChildCompositionSpaceTransform () const |
| Gets the transform used for composition children of the 2D node. | |
| size_t | getChildCount () const |
| Gets the number of children of the node. | |
| size_t | getChildIndex (const Node &child) const |
| Returns the index of a child in an object node. | |
| ClippingArea | getClippingArea () const |
| Gets the clipping area. | |
| BrushSharedPtr | getCompositionBrush () const |
| Gets value of CompositionBrushProperty. | |
| BrushRenderer * | getCompositionBrushRenderer () const |
| Access cache result brush renderer. | |
| CompositionManager * | getCompositionManager () const |
| Access composition manager. | |
| TextureSharedPtr | getCompositionTarget () const |
| Gets the composition target used for compositing the node. | |
| NodeCompositor2D * | getCompositor () const |
| Accesses the compositor component. | |
| Vector2 | getContentDesiredSize () const |
| Gets the size desired by content. | |
| Vector2 | getDesiredSize () const |
| Gets the desired size of a node. | |
| NodeEffect2DSharedPtr | getEffect () const |
| Gets the value of EffectProperty. | |
| NodeEffectPrefab2DSharedPtr | getEffectPrefab () const |
| Gets the value of EffectPrefabProperty. | |
| NodeEffectRenderer2D * | getEffectRenderer () const |
| Gets the effect renderer. | |
| BrushSharedPtr | getForegroundBrush () const |
| Gets value of ForegroundBrushProperty. | |
| BrushRenderer * | getForegroundBrushRenderer () const |
| Get foreground brush renderer. | |
| float | getLayoutOpacity () const |
| Gets the opacity after propagation from layouting hierarchy. | |
| SRTValue2D | getLayoutTransformation () const |
| Gets the value of the LayoutTransformationProperty. | |
| TextureSharedPtr | getManagedCompositionTarget () const |
| Gets the managed composition target of a node. | |
| Matrix3x3 | getParentSpaceTransform () const |
| Gets the parent space transform of the 2D node. | |
| Matrix3x3 | getPartialArrangeTransform () const |
| Gets the partial arrange transform. | |
| NodeEffect2D * | getRenderableEffect () const |
| Gets a pointer to the current effect if effect rendering is required. | |
| Matrix3x3 | getRenderQuadTransform () const |
| Gets transformation used to render the 2D node. | |
| TextureSharedPtr | getRenderTarget () const |
| Gets value of RenderTargetProperty. | |
| SRTValue2D | getRenderTransformation () const |
| Gets the value of RenderTransformationProperty. | |
| RenderType | getRenderType () const |
| Get render type. | |
| Vector2 | getSecondPassDesiredSize () const |
| Gets the second pass desired size. | |
| Vector2 | getUserDesiredSize () const |
| Gets the size desired by user. | |
| NodeVisual2D * | getVisual () const |
| Access visual component. | |
| Matrix3x3 | getWorldTransform () const |
| Gets the world transformation matrix. | |
| optional< Vector2 > | globalToLocal (Vector2 point) const |
| bool | hasCenterClipArea () const |
| Returns whether a 2D node has the center clip area (the area of foreground content). | |
| bool | hasChild (const Node &child) const |
| Returns whether the given node is a child of this node. | |
| bool | hasCompositionTarget () const |
| Indicates whether the node has a composition target. | |
| bool | hasEffect () const |
| Whether an active effect is applied to this node. | |
| bool | hasManagedCompositionTarget () const |
| Returns whether the node has a managed composition target. | |
| bool | hasOutsideClipArea () const |
| Returns whether a 2D node has outside clipping area. | |
| bool | hasTranslucentForeground () const |
| Returns whether the foreground of a 2D node has translucency. | |
| NodeSharedPtr | hitTest (Vector2 point) |
| Performs a hit test to a 2D node and all its child nodes. | |
| template<typename T > | |
| shared_ptr< T > | hitTest (Vector2 point) |
| Wrapper for hitTest(Vector2), casts the return value. | |
| NodeSharedPtr | hitTest (Vector2 point, const Metaclass *type) |
| Performs a hit test to a 2D node and all its child nodes. | |
| template<typename T > | |
| shared_ptr< T > | hitTest (Vector2 point, const Metaclass *type) |
| Wrapper for hitTest(Vector2, const Metaclass), casts the return value. | |
| virtual tuple< NodeSharedPtr, Ray, float > | hitTestContent (Vector2 point) |
| Default implementation of Node2D content hit test. | |
| NodeSharedPtr | hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData) |
| Hit tests nodes recursively from this node downwards and calls visitor function on the hit nodes. | |
| void | insertChild (size_t index, Node2DSharedPtr child) |
| Adds a child node for object node to given index. | |
| bool | isCacheValid () const |
| Returns whether the children cache is valid. | |
| bool | isClearColorAllowed () const |
| Returns whether this Node2D is allowed and should clear the color buffer of its own composition target. | |
| bool | isCompletelyClipped () const |
| Returns whether a node is completely clipped and needs not be rendered. | |
| bool | isCompletelyTransparent () const |
| Returns whether a node is completely transparent. | |
| bool | isCompositionPotentiallyRequired () const |
| Tell if node itself is going to get rendered into a composition target. | |
| bool | isPerspectiveTransformActive () const |
| Returns whether a node is being perspective transformed. | |
| bool | isRenderChildrenAllowed () const |
| Returns whether rendering children is allowed. | |
| bool | isRenderSelfAllowed () const |
| Returns whether render self is allowed. | |
| bool | isSelfInCompositionTarget () const |
| Returns whether the node is going to get rendered into a composition target. | |
| bool | isVisibleForHitTesting () const |
| Returns whether a 2D node is visible for hit testing. | |
| void | layout () |
| Does layout pass with no root transformation (identity). | |
| void | layout (optional< Matrix3x3 > rootTransform) |
| Does a layout pass starting from this node and iterating recursively all of its children. | |
| bool | measure (const Vector2 *availableSize, bool handleStretch) |
| Measures one node. | |
| virtual bool | measureRecursive () |
| Performs measure recursively. | |
| bool | moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override |
| Node::moveAbstractChildToPosition() implementation. | |
| void | moveChildToPosition (Node2DSharedPtr child, size_t index) |
| Moves a child node to a given position in the list of child nodes. | |
| void | moveToBack () |
| Repositions the node to the beginning of its parent's children, so that it is drawn first. | |
| void | moveToFront () |
| Repositions the node to the end of its parent's children, so that it is drawn last. | |
| ChildConstReverseIterator | rbeginChildren () const |
| bool | removeAbstractChildOverride (Node &child) override |
| Node::removeAbstractChildOverride() implementation. | |
| void | removeAllChildren () |
| Removes all child nodes. | |
| void | removeChild (const Node &child) |
| Removes child node. | |
| void | removeChild (size_t index) |
| Removes child node at specified index. | |
| ChildConstReverseIterator | rendChildren () const |
| void | render (Renderer3D &renderer, CompositionStack &compositionStack) |
| Render a node and its descendant nodes. | |
| void | render (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform) |
| Renders a node and its descendant nodes. | |
| bool | requiresBackgroundBrushRendering () const |
| Returns whether background brush rendering is required. | |
| bool | requiresForegroundBrushRendering () const |
| Returns whether foreground brush rendering is required. | |
| bool | requiresLocalTransformationScope () const |
| Indicates whether local transformation scope is required. | |
| bool | requiresTilingUpdate () const |
| Returns whether node geometry requires an update for the tiling. | |
| void | resetCache () |
| Resets cached content for complete content of a node, including the node and its children. | |
| void | setActualSize (float sizeX, float sizeY) |
| Sets the actual size of a node. | |
| void | setActualSize (Vector2 actualSize) |
| Sets the actual size of a node. | |
| void | setAllocatedSize (Vector2 allocatedSize) |
| Sets the allocated size of a node. | |
| void | setArrangeTransform (Matrix3x3 transform) |
| Sets the arrange transform. | |
| void | setAutoHeight () |
| Sets a node to determine its height automatically. | |
| void | setAutoSize () |
| Sets a node to determine its width and height automatically. | |
| void | setAutoWidth () |
| Sets a node to determine its width automatically. | |
| void | setBackgroundBrush (BrushSharedPtr value) |
| Sets value of BackgroundBrushProperty. | |
| void | setClearColorAllowed (bool enabled) |
| Sets clear color allowed. | |
| void | setCompositionBrush (BrushSharedPtr value) |
| Sets value of CompositionBrushProperty. | |
| void | setCompositionRequested (bool enabled) |
| Turns the composition request on or off. | |
| void | setCompositionRequiresAlpha (bool enabled) |
| Turns the composition alpha requirement on or off. | |
| void | setCompositionRequiresDepth (bool enabled) |
| Turns the composition depth requirement on or off. | |
| void | setCompositionRequiresStencil (bool enabled) |
| Turns the composition stencil requirement on or off. | |
| void | setDesiredSize (Vector2 desiredSize) |
| Sets the desired size of a node. | |
| void | setEffectPrefab (NodeEffectPrefab2DSharedPtr value) |
| Sets the value of EffectPrefabProperty. | |
| void | setForegroundBrush (BrushSharedPtr value) |
| Sets value of ForegroundBrushProperty. | |
| void | setForegroundIsTranslucent (bool enabled) |
| Sets the status of the foreground translucency. | |
| void | setForegroundTranslucencyRequested (bool enabled) |
| Enables or disables the foreground translucency request. | |
| KZ_DEPRECATED void | setLayoutSize (float width, float height) |
| Sets size properties of the node. | |
| void | setLayoutTransformation (SRTValue2D value) |
| Sets the value of the LayoutTransformationProperty. | |
| void | setPotentialCompositionBitViewport (bool enabled) |
| Turns the potential composition flag for the viewport on or off. | |
| void | setRenderTarget (TextureSharedPtr texture) |
| Sets value of RenderTargetProperty. | |
| void | setRenderTransformation (SRTValue2D value) |
| Sets the value of RenderTransformationProperty. | |
| void | setRequiresLocalTransformationScope (bool enabled) |
| Sets the local transformation scope requirement. | |
| void | setRequiresTilingUpdate (bool enabled) |
| Sets the tiling update requirement. | |
| void | setSize (float width, float height) |
| Sets the size of a node. | |
| void | setSize (Vector2 size) |
| Sets the size of a node. | |
| void | transform () |
| Transforms a 2D node. | |
| VisitorResult | visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override |
| Node::visitAbstractChild implementation. | |
| ~Node2D () override | |
| float | getAspectRatio () const |
| Gets the value of AspectRatioProperty. | |
| void | setAspectRatio (float value) |
| Sets the value of AspectRatioProperty. | |
| bool | isForceComposition () const |
| Gets the value of ForceCompositionProperty. | |
| void | setForceComposition (bool value) |
| Sets the value of ForceCompositionProperty. | |
| Node2D::ForegroundHint | getForegroundHint () const |
| Gets the value of ForegroundHintProperty. | |
| void | setForegroundHint (Node2D::ForegroundHint value) |
| Sets the value of ForegroundHintProperty. | |
| bool | isOffscreenRendering () const |
| Gets the value of OffscreenRenderingProperty. | |
| void | setOffscreenRendering (bool value) |
| Sets the value of OffscreenRenderingProperty. | |
| bool | isDisableRenderTargetClear () const |
| Gets the value of DisableRenderTargetClearProperty. | |
| void | setDisableRenderTargetClear (bool value) |
| Sets the value of DisableRenderTargetClearProperty. | |
| Node2D::PixelFormat | getPixelFormat () const |
| Gets the value of PixelFormatProperty. | |
| void | setPixelFormat (Node2D::PixelFormat value) |
| Sets the value of PixelFormatProperty. | |
| bool | isRenderSelf () const |
| Gets the value of RenderSelfProperty. | |
| void | setRenderSelf (bool value) |
| Sets the value of RenderSelfProperty. | |
| float | getRenderTargetMinimumHeight () const |
| Gets the value of RenderTargetMinimumHeightProperty. | |
| void | setRenderTargetMinimumHeight (float value) |
| Sets the value of RenderTargetMinimumHeightProperty. | |
| float | getRenderTargetMinimumWidth () const |
| Gets the value of RenderTargetMinimumWidthProperty. | |
| void | setRenderTargetMinimumWidth (float value) |
| Sets the value of RenderTargetMinimumWidthProperty. | |
| float | getRenderTargetReallocationLimit () const |
| Gets the value of RenderTargetReallocationLimitProperty. | |
| void | setRenderTargetReallocationLimit (float value) |
| Sets the value of RenderTargetReallocationLimitProperty. | |
| CachingMode | getCachingMode () const |
| Gets the value of CachingModeProperty. | |
| void | setCachingMode (CachingMode value) |
| Sets the value of CachingModeProperty. | |
| SRTValue3D | getPerspectiveTransformation () const |
| Gets the value of PerspectiveTransformationProperty. | |
| void | setPerspectiveTransformation (SRTValue3D value) |
| Sets the value of PerspectiveTransformationProperty. | |
| PerspectiveTransformationMode | getPerspectiveTransformationMode () const |
| Gets the value of PerspectiveTransformationModeProperty. | |
| void | setPerspectiveTransformationMode (PerspectiveTransformationMode value) |
| Sets the value of PerspectiveTransformationModeProperty. | |
| float | getPerspectiveTransformationFov () const |
| Gets the value of PerspectiveTransformationFovProperty. | |
| void | setPerspectiveTransformationFov (float value) |
| Sets the value of PerspectiveTransformationProperty. | |
| Vector3 | getPerspectiveTransformationPivot () const |
| Gets the value of PerspectiveTransformationPivotProperty. | |
| void | setPerspectiveTransformationPivot (Vector3 value) |
| Sets the value of PerspectiveTransformationPivotProperty. | |
| Vector3 | getPerspectiveTransformationOrigin () const |
| Gets the value of PerspectiveTransformationOriginProperty. | |
| void | setPerspectiveTransformationOrigin (Vector3 value) |
| Sets the value of PerspectiveTransformationOriginProperty. | |
| Vector2 | getRenderTransformationOrigin () const |
| Gets the value of RenderTransformationOriginProperty. | |
| void | setRenderTransformationOrigin (Vector2 value) |
| Sets the value of RenderTransformationOriginProperty. | |
| bool | isSnapToPixel () const |
| Gets the value of SnapToPixelProperty. | |
| void | setSnapToPixel (bool value) |
| Sets the value of SnapToPixelProperty. | |
| MultisampleCount | getMultisampleLevel () const |
| Gets the value of MultisampleLevelProperty. | |
| void | setMultisampleLevel (MultisampleCount value) |
| Sets the value of MultisampleLevelProperty. | |
| Public Member Functions inherited from kanzi::Node | |
| ResourceSharedPtr | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. | |
| ResourceManager::AcquireTaskSharedPtr | acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const |
| Posts an asynchronous task to acquire a resource. | |
| ResourceDictionarySharedPtr | acquireResourceDictionary () |
| Gets a resource dictionary of a node. | |
| void | addAnonymousResource (ResourceSharedPtr resource) |
| Adds alias resource to an object node. | |
| void | addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator) |
| Transfers the ownership and attaches an input manipulator to an object node. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message handler where the handler is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message handler where the handler is a method that is invoked on an object. | |
| void | addNodeComponent (NodeComponentSharedPtr nodeComponent) |
| Transfers the ownership of a node component to an object node. | |
| void | addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner) |
| Transfers the ownership of a node component to an object node and sets the owner of the node component. | |
| void | addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference) |
| void | addResource (const ResourceID &resourceId, string_view resourceUrl) |
| Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. | |
| void | addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Adds a nested resource dictionary to the resource dictionary of a node. | |
| void | addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| AppliedStyleEntrySharedPtr | applyManualStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| AppliedStyleEntrySharedPtr | applyStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| void | applyStyles () |
| Apply all styles for an object node. | |
| void | applyStylesRecursive () |
| Applies styles recursively. | |
| void | attachRecursive () |
| Attaches an object node and its children recursively. | |
| InputManipulatorConstIterator | beginInputManipulators () const |
| NodeComponentConstIterator | beginNodeComponents () const |
| void | clearChangeFlag (uint32_t flag) |
| Clears a change flag. | |
| void | clearChildChangeFlag (uint32_t flag) |
| Clears a child change flag. | |
| bool | containsResource (const ResourceID &resourceID) const |
| Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. | |
| BindingLookupContextPtr | createLookupContext (NodeSharedPtr templateRoot) |
| Creates a lookup context for the node. | |
| void | detachRecursive () |
| Detaches a node and its descendants. | |
| void | dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| template<typename TArgumentsType > | |
| void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| InputManipulatorConstIterator | endInputManipulators () const |
| NodeComponentConstIterator | endNodeComponents () const |
| template<typename TNodeType > | |
| shared_ptr< TNodeType > | findAbstractChild (string_view name) |
| Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. | |
| optional< string > | findResourceURL (const ResourceID &resourceId) const |
| Tries to find Resource URL for Resource ID from this node. | |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| uint32_t | getChangeFlags () const |
| Get current change flags. | |
| uint32_t | getChildChangeFlags () const |
| Get current child change flags. | |
| FocusManager * | getFocusManager () const |
| Returns the Focus Manager associated with the Screen node to which this node belongs. | |
| FocusScope * | getFocusScopeInfo () const |
| Returns the information about the focus scope for a node. | |
| InputManager * | getInputManager () const |
| Returns the Input Manager associated with the Screen node to which this node belongs. | |
| AbstractPropertyTypeDescriptor::ValueSource * | getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::DataType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| Node * | getParent () const |
| Returns the parent of the node. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. | |
| ResourceDictionarySharedPtr | getResourceDictionary () const |
| If a node has a resource dictionary, returns the resource dictionary of that node. | |
| Screen * | getScreen () const |
| Returns the Screen node to which this node belongs. | |
| NodeSharedPtr | getTemplateRoot () const |
| Gets the template root of this node. | |
| void | invalidateArrange () |
| Invalidates arrange. | |
| void | invalidateDraw () |
| Invalidates draw flag for the node. | |
| void | invalidateFinalTransform () |
| Invalidates final transform for node. | |
| void | invalidateMeasure () |
| Invalidates measure for the node. | |
| void | invalidateRender () |
| Invalidates render for node. | |
| bool | isAnyChangeFlagSet (uint32_t flag) const |
| Checks if any of given flags is set. | |
| bool | isAnyChildChangeFlagSet (uint32_t flag) const |
| Checks if any child change flags (corresponding to given mask) are set. | |
| bool | isAttached () const |
| Returns true if the node is attached to a screen or one of its descendants. | |
| bool | isAttaching () const |
| Returns true if node is in the process of attaching, false otherwise. | |
| bool | isChangeFlagSet (uint32_t flag) const |
| Checks if a change flag is set. | |
| bool | isChildChangeFlagSet (uint32_t flag) const |
| Checks if child change flags match. | |
| bool | isDetaching () const |
| Returns true if the node currently detaching. | |
| bool | isEffectivelyFocusable () const |
| Returns whether a node is focusable. | |
| bool | isEffectivelyVisible () const |
| Returns whether a node and its ancestor nodes are visible. | |
| bool | isInitialized () const |
| Returns true if initialize() has been called, false otherwise. | |
| bool | isInvalidArrange () const |
| Checks if the node needs arrange. | |
| bool | isInvalidDraw () |
| Tells if node draw flag is invalid. | |
| bool | isInvalidFinalTransform () const |
| Tells if final transform flag is invalid for node. | |
| bool | isInvalidMeasure () const |
| Check if the node needs measure. | |
| bool | isInvalidRender () const |
| Returns if node render flag is invalid. | |
| bool | isNamed (string_view name) const |
| KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty) | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNode (string_view pathOrKey) |
| Returns a node of specified type by looking it up with specified path or alias. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNodeComponent (string_view name) |
| Returns a node component of specified type by looking it up with specified name. | |
| Node * | lookupNodeRaw (string_view relativePath) |
| Get an object node by another node and a relative path. | |
| ObjectSharedPtr | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| tuple< NodeSharedPtr, AbstractPropertyType > | lookupObjectForStateManager (string_view relativePath) |
| Lookup for an node and possible object from within the node for state manager. | |
| void | notifyResourceDictionaryModified () |
| Forces the re-evaluation of resource IDs in a node tree. | |
| void | removeAnonymousResource (const Resource &resource) |
| Removes anonymous resource from object node resources. | |
| void | removeInputManipulator (InputManipulator &inputManipulator) |
| Removes the ownership and detaches an input manipulator from an object node. | |
| void | removeKZBData () |
| Destroys all object node data loaded from KZB. | |
| void | removeKZBData (flat_set< AbstractPropertyType > *keepProperties) |
| Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. | |
| void | removeNodeComponent (NodeComponent &nodeComponent) |
| Removes the ownership of a node component from an object node. | |
| void | removeNodeComponentWithOwner (const void *owner) |
| Removes all bindings with the specified owner. | |
| void | removeNodeReference (const AbstractNodeReference &reference) |
| void | removeResource (const ResourceID &resourceId) |
| Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. | |
| void | removeResourceReference (const AbstractResourceReference &reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| void | setChangeFlag (uint32_t flag) |
| Sets a change flag. | |
| void | setChildChangeFlag (uint32_t flag) |
| Sets a child change flag. | |
| void | setParent (Node *parent) |
| Kanzi uses this method internally to set the parent of a node. | |
| void | setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Replaces the resource dictionary of a node. | |
| void | setScreen (Screen *screen) |
| Sets the Screen node to which this node belongs. | |
| void | setTemplateRoot (NodeSharedPtr templateRoot) |
| Sets the template root of this node. | |
| ResourceSharedPtr | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. | |
| KZ_DEPRECATED NodeSharedPtr | trySetActiveFocus () |
| Tries to move the focus on this node. | |
| NodeSharedPtr | trySetFocus () |
| Tries to move the focus to this node. | |
| NodeSharedPtr | trySetFocus (FocusFallback fallbackOption) |
| Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. | |
| void | unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| Unapplies a style from an object node. | |
| void | unapplyStyles () |
| Unapplies and removes all applied styles. | |
| void | unapplyStylesRecursive () |
| Unapplies styles recursively. | |
| void | validateArrange () |
| Validates arrange. | |
| void | validateDraw () |
| Validates draw flags for the node. | |
| void | validateDrawForChildrenRecursive () |
| Recursively validates draw for the children from this 2D node onwards. | |
| void | validateMeasure () |
| Validates measure for the node. | |
| void | validateRender () |
| Validates render for node. | |
| VisitorResult | visit (const Visitor &visitor, VisitorOrder order) |
| Visits a node and its descendants. | |
| VisitorResult | visitDescendants (const Visitor &visitor, VisitorOrder order) |
| Visits the descendants of a node. | |
| ~Node () override | |
| Destructor. | |
| string | getName () const |
| Gets the value of NameProperty. | |
| void | setName (string_view value) |
| Sets the value of NameProperty. | |
| string | getPath () const |
| Gets the value of PathProperty. | |
| void | setPath (string value) |
| Sets the value of PathProperty. | |
| string | getLocale () const |
| Gets the value of LocaleProperty. | |
| void | setLocale (string value) |
| Sets the value of LocaleProperty. | |
| bool | isHitTestable () const |
| Gets the value of HitTestableProperty. | |
| void | setHitTestable (bool value) |
| Sets the value of HitTestableProperty. | |
| bool | isHitTestableContainer () const |
| Gets the value of HitTestableContainerProperty. | |
| void | setHitTestableContainer (bool value) |
| Sets the value of HitTestableContainerProperty. | |
| bool | isVisible () const |
| Gets the value of VisibleProperty. | |
| void | setVisible (bool value) |
| Sets the value of VisibleProperty. | |
| bool | isEnabled () const |
| Returns the value of the EnabledProperty. | |
| void | setEnabled (bool value) |
| Sets the value of the EnabledProperty. | |
| bool | isEffectivelyEnabled () const |
| Returns the value of EffectivelyEnabledProperty. | |
| bool | isFocusable () const |
| Gets the value of the FocusableProperty. | |
| void | setFocusable (bool value) |
| Sets the value of the FocusableProperty. | |
| bool | isFocused () const |
| Gets the value of the FocusedProperty. | |
| void | setFocused (bool value) |
| Sets the value of the FocusedProperty. | |
| FocusState | getFocusState () const |
| Gets the value of the FocusStateProperty. | |
| void | setFocusState (FocusState state) |
| Sets the value of the FocusStateProperty. | |
| FontFamilySharedPtr | getFontFamily () const |
| Gets the font family the node uses. | |
| void | setFontFamily (FontFamilySharedPtr value) |
| Sets the font family the node uses. | |
| float | getVisibleAmountInParent () const |
| Gets the value of VisibleAmountInParentProperty. | |
| void | setVisibleAmountInParent (float value) |
| Sets the value of VisibleAmountInParentProperty. | |
| float | getProjection2DTo3DScale () const |
| Gets the value of Projection2DTo3DScaleProperty. | |
| void | setProjection2DTo3DScale (float value) |
| Sets the value of Projection2DTo3DScaleProperty. | |
| ResourceSharedPtr | getStyle () const |
| Gets the value of StyleProperty. | |
| void | setStyle (ResourceSharedPtr value) |
| Sets the value of StyleProperty. | |
| ResourceSharedPtr | getStateManager () const |
| Gets the value of StateManagerProperty. | |
| void | setStateManager (ResourceSharedPtr value) |
| Sets the value of StateManagerProperty. | |
| float | getWidth () const |
| Gets the value of WidthProperty. | |
| void | setWidth (float value) |
| Sets the value of WidthProperty. | |
| float | getHeight () const |
| Gets the value of HeightProperty. | |
| void | setHeight (float value) |
| Sets the value of HeightProperty. | |
| float | getDepth () const |
| Gets the value of DepthProperty. | |
| void | setDepth (float value) |
| Sets the value of DepthProperty. | |
| float | getActualWidth () const |
| Gets the value of ActualWidthProperty. | |
| void | setActualWidth (float value) |
| Sets the value of ActualWidthProperty. | |
| float | getActualHeight () const |
| Gets the value of ActualHeightProperty. | |
| void | setActualHeight (float value) |
| Sets the value of ActualHeightProperty. | |
| float | getActualDepth () const |
| Gets the value of ActualDepthProperty. | |
| void | setActualDepth (float value) |
| Sets the value of ActualDepthProperty. | |
| Node::HorizontalAlignment | getHorizontalAlignment () const |
| Gets the value of HorizontalAlignmentProperty. | |
| void | setHorizontalAlignment (Node::HorizontalAlignment value) |
| Sets the value of HorizontalAlignmentProperty. | |
| Node::VerticalAlignment | getVerticalAlignment () const |
| Gets the value of VerticalAlignmentProperty. | |
| void | setVerticalAlignment (Node::VerticalAlignment value) |
| Sets the value of VerticalAlignmentProperty. | |
| Node::DepthAlignment | getDepthAlignment () const |
| Gets the value of DepthAlignmentProperty. | |
| void | setDepthAlignment (Node::DepthAlignment value) |
| Sets the value of DepthAlignmentProperty. | |
| Vector2 | getHorizontalMargin () const |
| Gets the value of HorizontalMarginProperty. | |
| void | setHorizontalMargin (Vector2 value) |
| Sets the value of HorizontalMarginProperty. | |
| Vector2 | getVerticalMargin () const |
| Gets the value of VerticalMarginProperty. | |
| void | setVerticalMargin (Vector2 value) |
| Sets the value of VerticalMarginProperty. | |
| Vector2 | getDepthMargin () const |
| Gets the value of DepthMarginProperty. | |
| void | setDepthMargin (Vector2 value) |
| Sets the value of DepthMarginProperty. | |
| Node::ContentStretch | getContentStretch () const |
| Gets the value of ContentStretchProperty. | |
| void | setContentStretch (Node::ContentStretch value) |
| Sets the value of ContentStretchProperty. | |
| float | getOpacity () const |
| Gets the value of OpacityProperty. | |
| void | setOpacity (float value) |
| Sets the value of OpacityProperty. | |
| bool | isHover () const |
| Returns whether the node has HoverProperty set to true. | |
| bool | isClipChildren () const |
| Gets the value of ClipChildrenProperty. | |
| void | setClipChildren (bool value) |
| Sets the value of ClipChildrenProperty. | |
| Public Member Functions inherited from kanzi::Object | |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. | |
| void | applyObjectStyles () |
| Apply all styles for an object node. | |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. | |
| const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object. | |
| MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain. | |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object. | |
| Object (Domain *domain) | |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object. | |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. | |
| ~Object () override | |
| Public Member Functions inherited from kanzi::MetaObject | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. | |
| virtual | ~MetaObject () |
| Public Member Functions inherited from kanzi::PropertyObject | |
| template<typename DataType > | |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers. | |
| template<typename DataType > | |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container. | |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object. | |
| void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object. | |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers. | |
| template<typename DataType > | |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type. | |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. | |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. | |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| PropertyObject () | |
| void | removeKzbProperties () |
| Remove all KZB properties. | |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set. | |
| template<typename DataType > | |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. | |
| template<typename DataType > | |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| template<typename DataType > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type. | |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| virtual | ~PropertyObject () |
| Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node > | |
| void | addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner) |
| Adds an already-created binding runtime to this binding host. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Sets a binding to a certain property. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Sets a modifier binding. | |
| Public Member Functions inherited from kanzi::BindingHostConcept | |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| Returns an iterator to the beginning of binding runtimes. | |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| Returns an iterator to the end of binding runtimes. | |
| AbstractBindingRuntimeSharedPtr | getBindingRuntime (size_t idx) |
| Gets binding by index. | |
| size_t | getBindingRuntimeCount () const |
| Gets the number of binding runtimes added to this node. | |
| void | removeAllBindings () |
| Removes all binding runtimes. | |
| void | removeBinding (BindingRuntimeHandle &bindingRuntime) |
| Removes a binding runtime added earlier. | |
| void | removeBindingsWithOwner (shared_ptr< void > owner) |
| Removes all binding runtimes with the specified owner. | |
| Static Public Attributes inherited from kanzi::Node2D | |
| static PropertyType< float > | AspectRatioProperty |
| AspectRatio property. | |
| static PropertyType< bool > | ForceCompositionProperty |
| ForceComposition property. | |
| static PropertyType< Node2D::ForegroundHint > | ForegroundHintProperty |
| ForegroundHint property. | |
| static PropertyType< bool > | OffscreenRenderingProperty |
| OffscreenRendering property. | |
| static PropertyType< bool > | DisableRenderTargetClearProperty |
| DisableRenderTargetClear property. | |
| static PropertyType< Node2D::PixelFormat > | PixelFormatProperty |
| PixelFormat property. | |
| static PropertyType< bool > | RenderSelfProperty |
| RenderSelf property. | |
| static PropertyType< ResourceSharedPtr > | RenderTargetProperty |
| RenderTarget property. | |
| static PropertyType< float > | RenderTargetMinimumHeightProperty |
| RenderTargetMinimumHeight property. | |
| static PropertyType< float > | RenderTargetMinimumWidthProperty |
| RenderTargetMinimumWidth property. | |
| static PropertyType< float > | RenderTargetReallocationLimitProperty |
| RenderTargetReallocationLimit property. | |
| static PropertyType< CachingMode > | CachingModeProperty |
| Sets the caching mode: | |
| static PropertyType< bool > | CacheValidProperty |
| Kanzi sets the value of this property to indicate whether the node is cached. | |
| static PropertyType< SRTValue2D > | LayoutTransformationProperty |
| Sets the layout transformation of the node. | |
| static PropertyType< SRTValue2D > | RenderTransformationProperty |
| Sets the render transformation of the node. | |
| static PropertyType< SRTValue3D > | PerspectiveTransformationProperty |
| Sets the perspective transformation of the node. | |
| static PropertyType< PerspectiveTransformationMode > | PerspectiveTransformationModeProperty |
| Sets the perspective transformation mode of the node. | |
| static PropertyType< float > | PerspectiveTransformationFovProperty |
| PerspectiveTransformationFov property. | |
| static PropertyType< Vector3 > | PerspectiveTransformationPivotProperty |
| PerspectiveTransformationOrigin property. | |
| static PropertyType< Vector3 > | PerspectiveTransformationOriginProperty |
| PerspectiveTransformationOrigin property. | |
| static PropertyType< Vector2 > | RenderTransformationOriginProperty |
| RenderTransformationOrigin property. | |
| static PropertyType< bool > | SnapToPixelProperty |
| SnapToPixel property. | |
| static PropertyType< ResourceSharedPtr > | BackgroundBrushProperty |
| BackgroundBrush property. | |
| static PropertyType< ResourceSharedPtr > | CompositionBrushProperty |
| CompositionBrush property. | |
| static PropertyType< ResourceSharedPtr > | ForegroundBrushProperty |
| ForegroundBrush property. | |
| static PropertyType< ResourceSharedPtr > | EffectProperty |
| Reports the runtime effect instance used by the node, instantiated from the NodeEffectPrefab2D. | |
| static PropertyType< ResourceSharedPtr > | EffectPrefabProperty |
| Sets the 2D Effect prefab to use for the node. | |
| static PropertyType< MultisampleCount > | MultisampleLevelProperty |
| Sets the number of anti-aliasing samples to use for temporary composition targets. | |
| Static Public Attributes inherited from kanzi::Node | |
| static PropertyType< string > | NameProperty |
| Name property. | |
| static PropertyType< string > | PathProperty |
| Path property. | |
| static PropertyType< string > | LocaleProperty |
| Locale property. | |
| static PropertyType< bool > | CreatedFromKZBProperty |
| CreatedFromKZB property. | |
| static PropertyType< bool > | HitTestableProperty |
| HitTestable property. | |
| static PropertyType< bool > | HitTestableContainerProperty |
| HitTestableContainer property. | |
| static PropertyType< bool > | VisibleProperty |
| Visible property. | |
| static PropertyType< bool > | EnabledProperty |
| Sets whether the node is enabled. | |
| static PropertyType< bool > | EffectivelyEnabledProperty |
| Indicates whether the node and its ancestor nodes are enabled. | |
| static PropertyType< bool > | FocusableProperty |
| Sets whether a node can get focus and can participate in the focus chain navigation. | |
| static PropertyType< bool > | FocusedProperty |
| Sets whether a node is an focus node and can receive key messages. | |
| static PropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a focusable node or focus scope node. | |
| static PropertyType< ResourceSharedPtr > | FontFamilyProperty |
| Sets the font family the node uses. | |
| static PropertyType< float > | VisibleAmountInParentProperty |
| VisibleAmountInParent property. | |
| static PropertyType< float > | Projection2DTo3DScaleProperty |
| Projection2DTo3DScale property. | |
| static PropertyType< ResourceSharedPtr > | StyleProperty |
| Style property. | |
| static PropertyType< ResourceSharedPtr > | StateManagerProperty |
| StateManager property. | |
| static PropertyType< void * > | PrefabTemplateSourceProperty |
| PrefabTemplateSource property. | |
| static PropertyType< float > | WidthProperty |
| Width property. | |
| static PropertyType< float > | HeightProperty |
| Height property. | |
| static PropertyType< float > | DepthProperty |
| Depth property. | |
| static PropertyType< float > | ActualWidthProperty |
| ActualWidth property. | |
| static PropertyType< float > | ActualHeightProperty |
| ActualHeight property. | |
| static PropertyType< float > | ActualDepthProperty |
| ActualDepth property. | |
| static PropertyType< Node::HorizontalAlignment > | HorizontalAlignmentProperty |
| HorizontalAlignment property. | |
| static PropertyType< Node::VerticalAlignment > | VerticalAlignmentProperty |
| VerticalAlignment property. | |
| static PropertyType< Node::DepthAlignment > | DepthAlignmentProperty |
| DepthAlignment property. | |
| static PropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Vector2 > | DepthMarginProperty |
| Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Node::ContentStretch > | ContentStretchProperty |
| ContentStretch property. | |
| static PropertyType< float > | OpacityProperty |
| Opacity property. | |
| static PropertyType< bool > | HoverProperty |
| Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. | |
| static PropertyType< bool > | ClipChildrenProperty |
| ClipChildren property. | |
| static PropertyType< int > | SceneGraphAddNodeChangeChildFlagsProperty |
| SceneGraphAddNodeChangeChildFlags property. | |
| static PropertyType< int > | SceneGraphAddNodeChangeParentFlagsProperty |
| SceneGraphAddNodeChangeParentFlags property. | |
| static PropertyType< int > | SceneGraphRemoveNodeChangeChildFlagsProperty |
| SceneGraphRemoveNodeChangeChildFlags property. | |
| static PropertyType< int > | SceneGraphRemoveNodeChangeParentFlagsProperty |
| SceneGraphRemoveNodeChangeParentFlags property. | |
| Protected Types inherited from kanzi::Node2D | |
| enum | Node2DFlags { AllowClear , AllowRenderChildren , AllowRenderSelf , ForegroundIsTranslucent , ForegroundTranslucencyRequested , RequiresBackgroundQuad , RequiresLocalTransformationScope , RequiresTilingUpdate , Node2DFlagsBitCount } |
| Different Node2D flags for bit set. More... | |
| Protected Types inherited from kanzi::Object | |
| typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
| Applied style container. | |
| Static Protected Member Functions inherited from kanzi::Node | |
| static VisitorResult | applyStylesVisitor (Node &node, bool apply) |
| static VisitorResult | attachVisitor (Node &node) |
| static VisitorResult | detachVisitor (Node &node) |
| static bool | processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason) |
| Processes notification handlers for node and property storage. | |
| static VisitorResult | propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason) |
| static VisitorResult | updateAllResourcesVisitor (Node &node) |
| static VisitorResult | updateResourceVisitor (Node &node, const ResourceID &id) |
| static VisitorResult | validateDrawVisitor (Node &node) |
| Visitor for validating draw. | |
| Protected Attributes inherited from kanzi::Node2D | |
| QuadDescription | m_backgroundQuadDescription |
| Background clipping quad / composition quad description. | |
| NodeEffect2DSharedPtr | m_cachedEffect |
| Cached effect instance. | |
| ClippingArea | m_clipping |
| Clipping parameters. | |
| CompositionRequirements | m_compositionRequirements |
| Composition requirements for this 2D node. | |
| unique_ptr< NodeCompositor2D > | m_compositor |
| Composition and caching information. | |
| NodeEffectPrefab2DSharedPtr | m_currentEffectPrefab |
| Currently instantiated effect prefab. | |
| optional< QuadDescription > | m_effectQuadDescription |
| Effect quad description. | |
| unsigned int | m_validatedEffectPaddingChangeCounter |
| Effect padding change counter value at which effect quad was last validated. | |
| unique_ptr< NodeVisual2D > | m_visual |
| Visual information. | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. | |
| Protected Attributes inherited from kanzi::BindingHostConcept | |
| BindingRuntimeContainer | m_bindingRuntimes |
| Bindings in this object. | |
Detailed Description
Empty Node 2D can be used to group other 2D nodes.
Constructor & Destructor Documentation
◆ EmptyNode2D()
|
explicitprotected |
Constructor.
- Parameters
-
domain Domain to use. name The name of the node.
Member Function Documentation
◆ create() [1/3]
|
static |
Creates an empty node.
- Parameters
-
domain UI domain to use. name Node name.
◆ create() [2/3]
|
static |
◆ create() [3/3]
The documentation for this class was generated from the following file:
- kanzi/core.ui/node/empty_node2d.hpp